Deploying britt-github-com with    Cloudflare Pages

View logs

📚 Documentation Style Guide

Documentation Style Guide

Project Summary

Project: "Hi. Welcome to brittcrawford.com." is a personal website built with Hugo (theme: hugo-coder). Current content is brief — a business-card style front page with links and short descriptions — but the repository contains multiple content sections (projects, cocktails, example posts) and theme documentation. Purpose and goals: provide a concise personal site that can be expanded with posts, projects, recipe-style content (cocktails), and small API/documentation-style pages. Audience: primarily general visitors and the site owner as content author; secondary audience includes future contributors who may add posts, project pages, or content collections. Technical details: Hugo static site generator, content/ organized into sections, archetypes/default.md present, theme in themes/hugo-coder, static assets under static/img and static/, layouts/index.html available. Metadata is used widely in front matter (title, path, date, draft). Table of Contents is used in some pages; code examples, tables, and API-style data appear in docs (theme docs and possibly site pages). Overall technical complexity: low-to-moderate — simple Markdown + Front Matter for authors who are comfortable with basic Markdown and Hugo concepts.

Context

Project: Hi. Welcome to brittcrawford.com.
Description: This is my personal website. Right now it just has a business card-like list of links and a non-committal description. I might add more to it in the future.
Publishing System: Hugo

Primary Documentation Goals

Writing Rules

Core Principles

• Be concise - Use the minimum words necessary
• Be practical - Focus on actionable information
• Be example-driven - Show working code for every concept
• Be consistent - Match existing documentation patterns

Tone Guidelines

Default Tone (Technical Users)

• Direct and practical language
• Assume familiarity with TypeScript, package managers, CLI
• Use technical jargon and shorthand
• Focus on code examples over explanations
• Avoid marketing language or benefit statements

Non-Technical User Adjustments

When explicitly writing for non-technical users:

• Explain what each command does and why
• Spell out abbreviations and technical terms
• Provide simpler code examples with explanations
• Include more step-by-step guidance
• Link to additional learning resources

Publishing System Requirements

Hugo-specific publishing requirements and front-matter conventions

Required metadata fields

• title (string): human readable title; required for all content files
• path (string): page path/slug used in the site (repository uses a "path" field frequently)
• date (RFC3339 timestamp or YYYY-MM-DD): publication or creation date

Optional but recommended fields

• draft (boolean; default: false) — set true while authoring
• description (string) — SEO / summary
• tags (array) — for posts/categories
• categories (array)
• thumbnail / image (st

... (truncated)

View full style guide

@doc.holiday remove the release notes and Add a link to the bottom of the page in _index.md noting that this site is coauthored by doc.holiday, link it to https://doc.holiday/

@doc.holiday remove the release notes and Add a link to the bottom of the page in _index.md noting that this site is coauthored by doc.holiday, link it to https://doc.holiday/

The release notes have been removed from the repository, and I've added 'Coauthored by doc.holiday' to the bottom of content/_index.md as requested. All actions are completed and verified. If you need further edits or formatting adjustments, let me know!